Skip to content

docs: a contributing page for working on the system - #551

Merged
leeovery merged 1 commit into
mainfrom
docs/contributing
Jul 27, 2026
Merged

docs: a contributing page for working on the system#551
leeovery merged 1 commit into
mainfrom
docs/contributing

Conversation

@leeovery

@leeovery leeovery commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds docs/contributing.md — everything in docs/ describes the product; nothing described the repository that produces it. Covers clone-to-green setup, the four local gates (and that there is no CI), rebuilding the knowledge bundle, and pointers to CLAUDE.md / CONVENTIONS.md.
  • Documents the prerequisite that cost most of a session to find: frontmatter hooks in a project subagent only run once the workspace trust dialog has been accepted for the folder (2.1.218+), and until then they fail silently. /hooks shows nothing for an inactive agent, and hasCompletedProjectOnboarding can read true while trust is still false — so an old checkout looks set up and quietly isn't. Includes a one-liner to check it.
  • Other known hiccups: agent definitions are cached per session, snapshot drift after engine changes is expected and how to regenerate, CHANGELOG.md is generated, shipped .sh migrations are frozen. Plus the never-pipe-a-gate rule, which produced a falsely-green report before.
  • Linked from both README.md and docs/README.md.

Deliberately thin — it grows as we hit things.

Test plan

  • Docs only; no behaviour changes.
  • The trust-check one-liner in the page was run against this repo and returns the expected value.

🤖 Generated with Claude Code

Stack

  1. docs(design): prose-tests programme design log #544
  2. feat(prose-tests): the framework — cases, worlds, runner, skill #545
  3. test(prose): feature happy-path corpus — five worlds, seven cases #546
  4. test(prose): bugfix corpus — the investigation-centric surfaces #548
  5. test: retry recursive teardown removals — kill a class of phantom failures #549
  6. fix(entry-skills): close the handoff fences — six files render their arms wrong #550
  7. docs: a contributing page for working on the system #551 👈 current
  8. fix(entry-skills): every handoff arm says to invoke the skill #552
  9. fix(implementation): environment setup belongs to the setup reference alone #553
  10. fix(prose-tests): the asserter is told which substitutions were armed #554
  11. feat(prose-tests): the mid-flow substitution, and a world only prose can describe #555
  12. test(prose): claims assert consequences, not what was displayed #556
  13. feat(prose-tests): record everything the agents do, results included #557
  14. fix(discussion-entry): the handoff reports the source it actually had #558
  15. fix(prose-tests): the stop hook records, and names the model that walked #559
  16. fix(prose-tests): command output was never actually recorded #560
  17. feat(prose-tests): judge the walk as told, not the summary returned #561
  18. feat(prose-tests): decide in code what an agent should not be deciding #562
  19. test(prose): a case starts where a session starts #563
  20. feat(prose-tests): walk on Sonnet, judge on Opus, escalate a failure #564
  21. test(prose): give the eight read-only cases something that can fail #565
  22. test(prose): only walks that can be observed, and checks that survive the trip #566
  23. fix(prose-tests): the verdict names only the model the record names #567
  24. test(prose): discovery, walked to the point where work first exists #568
  25. fix(prose-tests): the asserter judges which of prose or walker was at fault #569
  26. docs(conventions): a step whose reference routes every exit still signposts #570
  27. test(prose): discovery's epic arm, to the same durability boundary #571
  28. fix(prose-tests): keep the walk's closing turn, and name the one live difference #572
  29. fix(prose-tests): prescribe the cross-check, drop a check that cannot fire, lint the scope #573
  30. test(prose): declare the prose each case actually walks #574
  31. fix(investigation): the symptom interview never ran for work shaped in discovery #575
  32. feat(prose-tests): conduct — playing a person where a script cannot reach #576
  33. fix(prose-tests): what a write put in a file is evidence, not incident #577
  34. fix(investigation): the interview starts from the carrier, not over it #578
  35. test(prose): quick-fix scoping, the whole definition stage in one walk #579
  36. fix(prose-tests): the world log is the walker's record #580
  37. fix(prose-tests): a confirmed failure reports both runs' checks #581
  38. fix(prose-tests): each prescribed command runs as written #582
  39. fix(scoping): context gathering reads the whole carrier, asks only the gaps #583

This was referenced Jul 26, 2026
@leeovery
leeovery force-pushed the fix/entry-handoff-fences branch from 4358bc6 to b47bb56 Compare July 27, 2026 14:32
@leeovery
leeovery force-pushed the docs/contributing branch from 52f416f to bf2c67f Compare July 27, 2026 14:32
@leeovery
leeovery force-pushed the fix/entry-handoff-fences branch from b47bb56 to d99ca63 Compare July 27, 2026 14:34
@leeovery
leeovery force-pushed the docs/contributing branch from bf2c67f to f051286 Compare July 27, 2026 14:34
@leeovery
leeovery force-pushed the fix/entry-handoff-fences branch from d99ca63 to f09f965 Compare July 27, 2026 14:36
@leeovery
leeovery force-pushed the docs/contributing branch from f051286 to 3b02bab Compare July 27, 2026 14:37
@leeovery
leeovery force-pushed the fix/entry-handoff-fences branch from f09f965 to fc90513 Compare July 27, 2026 14:39
@leeovery
leeovery force-pushed the docs/contributing branch from 3b02bab to c4da5c4 Compare July 27, 2026 14:39
@leeovery
leeovery force-pushed the fix/entry-handoff-fences branch from fc90513 to aa23cbc Compare July 27, 2026 14:41
@leeovery
leeovery force-pushed the docs/contributing branch from c4da5c4 to 78dc5f1 Compare July 27, 2026 14:41
@leeovery
leeovery changed the base branch from fix/entry-handoff-fences to main July 27, 2026 14:43
Everything in docs/ describes the product; nothing described the
repository that produces it. This covers clone-to-green setup, the four
local gates (and that there is no CI), rebuilding the knowledge bundle,
and the conventions that are mandatory before editing skills.

The prose-test section carries the prerequisite that cost most of a
session to find: frontmatter hooks in a project subagent only run once
the workspace trust dialog is accepted for the folder, and until then
they fail silently — no warning, and /hooks shows nothing for an
inactive agent. hasCompletedProjectOnboarding can read true while trust
is still false, so an old checkout looks set up and quietly isn't.

Deliberately thin elsewhere; it grows as we hit things.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@leeovery
leeovery force-pushed the docs/contributing branch from 78dc5f1 to 7c1dd40 Compare July 27, 2026 14:43
@leeovery
leeovery merged commit 2bebc53 into main Jul 27, 2026
@leeovery
leeovery deleted the docs/contributing branch July 27, 2026 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant